Skip to content

IBX-10688: SiteAccess-aware Raptor connector configuration documented in Dev-doc#3101

Open
julitafalcondusza wants to merge 12 commits into5.0from
IBX-10688_config
Open

IBX-10688: SiteAccess-aware Raptor connector configuration documented in Dev-doc#3101
julitafalcondusza wants to merge 12 commits into5.0from
IBX-10688_config

Conversation

@julitafalcondusza
Copy link
Copy Markdown
Contributor

@julitafalcondusza julitafalcondusza commented Mar 20, 2026

Question Answer
JIRA Ticket IBX-10688 ibexa/connector-raptor#2
Versions 5.0
Editions Headless+

SiteAccess-aware Raptor connector configuration documented in Dev-doc

Checklist

  • Text renders correctly
  • Text has been checked with vale
  • Description metadata is up to date
  • Redirects cover removed/moved pages
  • Code samples are working
  • PHP code samples have been fixed with PHP CS fixer
  • Added link to this PR in relevant JIRA ticket or code PR

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 20, 2026

Copy link
Copy Markdown
Member

@alongosz alongosz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks good, but would be nice to see this in preview build which is currently failing

@julitafalcondusza julitafalcondusza marked this pull request as ready for review March 30, 2026 12:43
@adriendupuis adriendupuis added the Wait with merge PRs that shouldn't be merged instantly label Apr 1, 2026
@adriendupuis adriendupuis mentioned this pull request Apr 1, 2026
7 tasks
Copy link
Copy Markdown
Contributor

@adriendupuis adriendupuis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was confused in the first place by the fact that we already have Raptor features, so, why needing a new connector?… Before understanding the Recommandation scope of this new thing. This should be clarified.

It should also be clear that it's an LTS Update.

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Apr 3, 2026

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 3, 2026

code_samples/ change report

Before (on target branch)After (in current PR)

code_samples/recommendations/config/packages/ibexa_connector_raptor.yaml


code_samples/recommendations/config/packages/ibexa_connector_raptor.yaml

docs/recommendations/raptor_integration/connector_configuration.md@18:``` yaml
docs/recommendations/raptor_integration/connector_configuration.md@19:[[= include_file('code_samples/recommendations/config/packages/ibexa_connector_raptor.yaml', 1, 14) =]]
docs/recommendations/raptor_integration/connector_configuration.md@20:```

001⫶ system:
002⫶ <scope>:
003⫶ connector_raptor:
004⫶ enabled: true
005⫶ customer_id: ~ # Required
006⫶ tracking_type: client # One of: "client" or "server"
007⫶
008⫶ # Raptor Recommendations API key
009⫶ recommendations_api_key: ~ # Required
010⫶
011⫶ # Raptor Recommendations API URL, optional, set by default
012⫶ recommendations_api_url: '%ibexa.connector.raptor.recommendations.api_url%'
013⫶ibexa_connector_raptor:

docs/recommendations/raptor_integration/connector_configuration.md@66:``` yaml hl_lines="14-17"
docs/recommendations/raptor_integration/connector_configuration.md@67:[[= include_file('code_samples/recommendations/config/packages/ibexa_connector_raptor.yaml') =]]
docs/recommendations/raptor_integration/connector_configuration.md@68:```

001⫶ibexa:
002⫶ system:
003⫶ <scope>:
004⫶ connector_raptor:
005⫶ enabled: true
006⫶ customer_id: ~ # Required
007⫶ tracking_type: client # One of: "client" or "server"
008⫶
009⫶ # Raptor Recommendations API key
010⫶ recommendations_api_key: ~ # Required
011⫶
012⫶ # Raptor Recommendations API URL, optional, set by default
013⫶ recommendations_api_url: '%ibexa.connector.raptor.recommendations.api_url%'
014❇️ibexa_connector_raptor:
015❇️ # When enabled, tracking exceptions are thrown instead of being silently handled
016❇️ strict_exceptions: true

Download colorized diff

[[= include_file('code_samples/recommendations/config/packages/ibexa_connector_raptor.yaml', 1, 14) =]]
```

- `enabled` - enables or disables the Connector for a given scope, default value: `true`. If set to `false`, no tracking or recommendation requests are executed.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `enabled` - enables or disables the Connector for a given scope, default value: `true`. If set to `false`, no tracking or recommendation requests are executed.
- `enabled` - enables or disables the connector for a given scope, default value: `true`. If set to `false`, no tracking or recommendation requests are executed.

description: Step-by-step configuration procedure of the Raptor connector.
---

# Installation
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Installation
# Configure Raptor connector


# Installation

First, install the Raptor connector.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
First, install the Raptor connector.
Before you can proceed to configuring the integration with Raptor, install the connector.

@@ -0,0 +1,68 @@
---
description: Step-by-step configuration procedure of the Raptor connector.
---
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
---
month_change: true
---


# SiteAccess-aware configuration

To configure Raptor connector, use the `ibexa.system.<scope>.connector_raptor` configuration key in the `config/packages/ibexa_connector_raptor.yaml` file:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To configure Raptor connector, use the `ibexa.system.<scope>.connector_raptor` configuration key in the `config/packages/ibexa_connector_raptor.yaml` file:
To configure the Raptor connector, use the `ibexa.system.<scope>.connector_raptor` configuration key in the `config/packages/ibexa_connector_raptor.yaml` file:


The [Raptor](https://www.raptorservices.com/) connector provides a seamless integration between [[= product_name =]] and Raptor Recommendation Engine.

Its primary goal is to enable editors and managers to deliver personalized experiences across digital channels, which helps to increase conversion rates, drive sales, and improve user engagement.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Its primary goal is to enable editors and managers to deliver personalized experiences across digital channels, which helps to increase conversion rates, drive sales, and improve user engagement.
Its primary goal is to enable editors and managers to deliver personalized experiences across digital channels, which helps increase conversion rates, drive sales, and improve user engagement.


Its primary goal is to enable editors and managers to deliver personalized experiences across digital channels, which helps to increase conversion rates, drive sales, and improve user engagement.

By combining content management capabilities with advanced recommendation features, the Connector allows teams to build and manage personalized experiences directly within a single platform.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
By combining content management capabilities with advanced recommendation features, the Connector allows teams to build and manage personalized experiences directly within a single platform.
By combining content management capabilities with advanced recommendation features, the connector allows teams to build and manage personalized experiences directly within a single platform.


By combining content management capabilities with advanced recommendation features, the Connector allows teams to build and manage personalized experiences directly within a single platform.

This connector ensures a smooth and unified integration layer, enabling:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This connector ensures a smooth and unified integration layer, enabling:
The connector ensures a smooth and unified integration layer, enabling:


This approach reduces integration complexity while providing a scalable foundation for personalization use cases across multiple sites and markets.

To configure the Raptor integration. follow a step-by-step procedure that allows you to activate the Raptor connector.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To configure the Raptor integration. follow a step-by-step procedure that allows you to activate the Raptor connector.
To configure the integration with Raptor, follow a step-by-step procedure that allows you to activate the Raptor connector.

Comment on lines +2 to +4
description: Step-by-step activation procedure of setting up the Raptor connector.
page_type: landing_page
---
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Step-by-step activation procedure of setting up the Raptor connector.
page_type: landing_page
---
description: Deliver personalized experiences across digital channels with the Raptor connector.
page_type: landing_page
month_change: true
---

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs DOC review Wait with merge PRs that shouldn't be merged instantly

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants